| Fully Qualified Name: | Laminas\Router\SimpleRouteStack |
| Implements: | RouteStackInterface |
Simple route stack implementation.
| Name | Description | Defined By |
|---|---|---|
| __construct() | Create a new simple route stack. | SimpleRouteStack |
| addRoute() | addRoute(): defined by RouteStackInterface interface. | SimpleRouteStack |
| addRoutes() | addRoutes(): defined by RouteStackInterface interface. | SimpleRouteStack |
| assemble() | assemble(): defined by RouteInterface interface. | SimpleRouteStack |
| factory() | factory(): defined by RouteInterface interface. | SimpleRouteStack |
| getRoute() | Get a route by name | SimpleRouteStack |
| getRoutePluginManager() | Get the route plugin manager. | SimpleRouteStack |
| getRoutes() | Get the added routes | SimpleRouteStack |
| hasRoute() | Check if a route with a specific name exists | SimpleRouteStack |
| match() | match(): defined by RouteInterface interface. | SimpleRouteStack |
| removeRoute() | removeRoute(): defined by RouteStackInterface interface. | SimpleRouteStack |
| setDefaultParam() | Set a default parameter. | SimpleRouteStack |
| setDefaultParams() | Set a default parameters. | SimpleRouteStack |
| setRoutePluginManager() | Set the route plugin manager. | SimpleRouteStack |
| setRoutes() | setRoutes(): defined by RouteStackInterface interface. | SimpleRouteStack |
Create a new simple route stack.
| Parameter Name | Type | Description |
|---|---|---|
| $routePluginManager | \RoutePluginManager |
Returns:
addRoute(): defined by RouteStackInterface interface.
| Parameter Name | Type | Description |
|---|---|---|
| $name | string | |
| $route | mixed | |
| $priority | int |
Returns: \SimpleRouteStack
addRoutes(): defined by RouteStackInterface interface.
| Parameter Name | Type | Description |
|---|---|---|
| $routes | array|\Traversable |
Returns: \SimpleRouteStack
assemble(): defined by RouteInterface interface.
| Parameter Name | Type | Description |
|---|---|---|
| $params | array | |
| $options | array |
Returns: mixed
factory(): defined by RouteInterface interface.
| Parameter Name | Type | Description |
|---|---|---|
| $options | array|\Traversable |
Returns: \SimpleRouteStack
Get a route by name
| Parameter Name | Type | Description |
|---|---|---|
| $name | string |
Returns: \RouteInterface the route
Get the route plugin manager.
Returns: \RoutePluginManager
Get the added routes
Returns: \Traversable list of all routes
Check if a route with a specific name exists
| Parameter Name | Type | Description |
|---|---|---|
| $name | string |
Returns: bool true if route exists
match(): defined by RouteInterface interface.
| Parameter Name | Type | Description |
|---|---|---|
| $request | \Request |
Returns: \RouteMatch|null
removeRoute(): defined by RouteStackInterface interface.
| Parameter Name | Type | Description |
|---|---|---|
| $name | string |
Returns: \SimpleRouteStack
Set a default parameter.
| Parameter Name | Type | Description |
|---|---|---|
| $name | string | |
| $value | mixed |
Returns: \SimpleRouteStack
Set a default parameters.
| Parameter Name | Type | Description |
|---|---|---|
| $params | array |
Returns: \SimpleRouteStack
Set the route plugin manager.
| Parameter Name | Type | Description |
|---|---|---|
| $routePlugins | \RoutePluginManager |
Returns: \SimpleRouteStack
setRoutes(): defined by RouteStackInterface interface.
| Parameter Name | Type | Description |
|---|---|---|
| $routes | array|\Traversable |
Returns: \SimpleRouteStack